Implement filter metrics list command by vishrutshah · Pull Request #2 · vishrutshah/azure-cli

vishrutshah · 2017-02-23T16:50:18Z

Before:

(env) D:\Repos\azure-cli>az monitor metrics list -h

Command
    az monitor metrics list: **Lists the metric values for a resource**.
        <br>The **$filter** is used to reduce the set of metric data returned. Some common
        properties for this expression will be: name.value, aggregationType, startTime, endTime,
        timeGrain. The filter expression uses these properties with comparison operators (eg. eq,
        gt, lt) and multiple expressions can be combined with parentheses and 'and/or'
        operators.<br>Some example filter expressions are:<br>- $filter=(name.value eq
        'RunsSucceeded') and aggregationType eq 'Total' and startTime eq 2016-02-20 and endTime eq
        2016-02-21 and timeGrain eq duration'PT1M',<br>- $filter=(name.value eq 'RunsSucceeded') and
        (aggregationType eq 'Total' or aggregationType eq 'Average') and startTime eq 2016-02-20 and
        endTime eq 2016-02-21 and timeGrain eq duration'PT1H',<br>- $filter=(name.value eq
        'ActionsCompleted' or name.value eq 'RunsSucceeded') and (aggregationType eq 'Total' or
        aggregationType eq 'Average') and startTime eq 2016-02-20 and endTime eq 2016-02-21 and
        timeGrain eq duration'PT1M'.<br><br> >**NOTE**: When a metrics query comes in with multiple
        metrics, but with no aggregation types defined, the service will pick the Primary
        aggregation type of the first metrics to be used as the default aggregation type for all the
        metrics.

Arguments
    --resource-uri [Required]: The identifier of the resource.
    --filter                 : Reduces the set of data collected. The syntax allowed depends on the
                               operation. See the operation's description for details.

Global Arguments
    --debug                  : Increase logging verbosity to show all debug logs.
    --help -h                : Show this help message and exit.
    --output -o              : Output format.  Allowed values: json, jsonc, table, tsv.  Default:
                               json.
    --query                  : JMESPath query string. See http://jmespath.org/ for more information
                               and examples.
    --verbose                : Increase logging verbosity. Use --debug for full debug logs.

After:

(env) vishrut@visshamac azure-cli (implement-filter-metrics) $ az monitor metrics list -h

Command
    az monitor metrics list: Lists the metric values for a resource.

Arguments
    --resource-uri [Required]: The identifier of the resource.
    --time-grain   [Required]: The time grain. Granularity of the metric data returned in ISO 8601
                               duration format, eg "duration'PT1M'".
    --end-time               : The end time of the query. In ISO format with explicit indication of
                               timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500.
    --metric-names           : The list of metric names.
    --start-time             : The start time of the query. In ISO format with explicit indication
                               of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500.

Global Arguments
    --debug                  : Increase logging verbosity to show all debug logs.
    --help -h                : Show this help message and exit.
    --output -o              : Output format.  Allowed values: json, jsonc, table, tsv.  Default:
                               json.
    --query                  : JMESPath query string. See http://jmespath.org/ for more information
                               and examples.
    --verbose                : Increase logging verbosity. Use --debug for full debug logs.

Example 1:

az monitor metrics list --resource-uri '/subscriptions/xxxxx-xxx-xxx-xxx-xxx/resourceGroups/vishrutrg/providers/Microsoft.Web/sites/vishrutwebapp' --metric-names AverageResponseTime AverageMemoryWorkingSet --time-grain PT1M

Example 2:

az monitor metrics list --resource-uri '/subscriptions/xxxxx-xxx-xxx-xxx-xxx/resourceGroups/vishrutrg/providers/Microsoft.Web/sites/vishrutwebapp' --time-grain PT1M --metric-names AverageMemoryWorkingSet --start-time  2017-01-11T12:59:59Z --end-time 2017-01-30T12:59:59Z

XPlat CLI Reference: https://github.com/Azure/azure-xplat-cli/blob/dev/lib/commands/arm/insights/insights.metrics._js#L44

@troydai @tjprescott @derekbekoe Please review the PR when you get a chance. Thanks!

derekbekoe · 2017-02-23T23:10:17Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/custom.py

+    :param str metric_names: The list of metric names
+    '''
+    odata_filter = _metrics_odata_filter_builder(time_grain, start_time, end_time, metric_names)
+    print(odata_filter)


remove this?

indeed. i missed it :)

tjprescott

Mostly questions.

tjprescott · 2017-02-23T23:51:36Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/custom.py

+    '''Lists the metric values for a resource.
+    :param str resource_uri: The identifier of the resource
+    :param str time_grain: The time grain. Granularity of the metric data returned in ISO 8601
+                           duration format, eg "duration'PT1M'"


Is there a way for us to simplify this? Why would I have to type "duration'PT1M'"?

I think if we can converts HH:mm:ss into ISO 8601. Let me look and see whether we have done it somewhere or not or how can we do that.

tjprescott · 2017-02-23T23:52:46Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/custom.py

+                           timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500
+    :param str end_time: The end time of the query. In ISO format with explicit indication of
+                         timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500
+    :param str metric_names: The list of metric names


Should clarify "The space separated list of metric names." Otherwise you will get people using comma separated values.

tjprescott · 2017-02-23T23:53:26Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/custom.py

+        filters.append('({})'.format(metrics_filter))
+
+    if time_grain:
+        filters.append("timeGrain eq duration'{}'".format(time_grain))


So this would read "timeGrain eq duration'duration'PT1M''"?

Opps the help message is wrong. Help message should not be 'duration'PT1M'' only 'PT1M'

tjprescott · 2017-02-23T23:54:12Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/params.py

@@ -48,3 +48,6 @@

 with ParametersContext(command='monitor metric-definitions list') as c:
    c.argument('metric_names', None, nargs='+')


What is the None?

haha..silly i can just avoid that.

* initial update * update * add the CLI for 2017-04-18 swagger file * cognitive service cli - inital version' * rollback debug code change * style refactoring update * update * change the term text to yellow highlighted * code comment fix - update #1 * fix code comments - update #2 * 1.fix flake 8 styling error 2. add the depedencies in setup, * fix an change in our service legal terms. * fix a help.py styling issue * update the setup.py * update description of setup.py

Implement filter for metrics list command

53a4aa7

vishrutshah mentioned this pull request Feb 23, 2017

Azure Monitor cli commands for Managemnt & Data plane Azure/azure-cli#1953

Closed

derekbekoe reviewed Feb 23, 2017

View reviewed changes

derekbekoe approved these changes Feb 23, 2017

View reviewed changes

tjprescott reviewed Feb 23, 2017

View reviewed changes

addressing code review comments

3fd8cc4

vishrutshah merged commit 60972c4 into monitor-cli Feb 28, 2017

vishrutshah deleted the implement-filter-metrics branch February 28, 2017 01:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement filter metrics list command#2

Implement filter metrics list command#2
vishrutshah merged 2 commits intomonitor-clifrom
implement-filter-metrics

vishrutshah commented Feb 23, 2017

Uh oh!

derekbekoe Feb 23, 2017

Uh oh!

vishrutshah Feb 23, 2017

Uh oh!

tjprescott left a comment

Uh oh!

tjprescott Feb 23, 2017

Uh oh!

vishrutshah Feb 24, 2017

Uh oh!

tjprescott Feb 23, 2017

Uh oh!

vishrutshah Feb 24, 2017

Uh oh!

tjprescott Feb 23, 2017

Uh oh!

vishrutshah Feb 24, 2017

Uh oh!

tjprescott Feb 23, 2017

Uh oh!

vishrutshah Feb 24, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -48,3 +48,6 @@

		with ParametersContext(command='monitor metric-definitions list') as c:
		c.argument('metric_names', None, nargs='+')

Conversation

vishrutshah commented Feb 23, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tjprescott left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants